Swap ERC-20 support, update to toolkit v5 #99

fadeev · 2023-12-13T15:24:03Z

Looks like the swap example is not compatible with swapping to/from ERC-20s.

Currently, we're swapping the whole incoming amount to target ZRC-20.

example-contracts/omnichain/swap/contracts/Swap.sol

Lines 50 to 58 in 51373fb

    
           uint256 outputAmount = SwapHelperLib._doSwap( 
        
               systemContract.wZetaContractAddress(), 
        
               systemContract.uniswapv2FactoryAddress(), 
        
               systemContract.uniswapv2Router02Address(), 
        
               zrc20, 
        
               amount, 
        
               targetTokenAddress, 
        
               0 
        
           );

Then we check if the gas token is not equal to the target ZRC-20.

example-contracts/omnichain/swap/contracts/Swap.sol

Lines 60 to 64 in 51373fb

    
           (address gasZRC20, uint256 gasFee) = IZRC20(targetTokenAddress) 
        
               .withdrawGasFee(); 
        
           if (gasZRC20 != targetTokenAddress) revert WrongGasContract(); 
        
           if (gasFee >= outputAmount) revert NotEnoughToPayGasFee();

When we want to swap tMATIC for USDC (Goerli), the target ZRC-20 (USDC) will not match the gas token (gETH), so the swap will fail. This is issue 1.

If I understand correctly, for the swap to succeed the contract has to have uint256 gasFee amount of address gasZRC20 to cover the gas costs when withdrawing the target ZRC-20. Right now we're only swapping to the target ZRC-20 and the contract does not have gas tokens. This is issue 2.

@andresaiello please, let me know if you agree that both issues are valid.

To solve these issues I'm proposing we do the following:

Determine the required gas fee amount using IZRC20(targetTokenAddress).withdrawGasFee();
Swap to get the required gas fee amount using SwapHelperLib.swapTokensForExactTokens
Swap the rest to get the target amount using SwapHelperLib._doSwap.

For this to work I've added a swapTokensForExactTokens helper:

https://github.com/zeta-chain/toolkit/blob/bc629af99832689697b2c45a6560b1b5df382d66/contracts/SwapHelperLib.sol#L127-L164

The problem I'm facing right now is that when I try to interact with a contract:

https://zetachain-athens-3.blockscout.com/address/0x7F665c57796E19a6A938f2B6dDbc5Ac5576c5De7

npx hardhat interact --contract 0x7F665c57796E19a6A938f2B6dDbc5Ac5576c5De7 --amount 1 --network mumbai_testnet --target-token 0x0cbe0dF132a6c6B4a2974Fa1b7Fb953CF0Cc798a --recipient 0x2cD3D070aE1BD365909dD859d29F387AA96911e1
🔑 Using account: 0x2cD3D070aE1BD365909dD859d29F387AA96911e1

🚀 Successfully broadcasted a token transfer transaction on mumbai_testnet network.
📝 Transaction hash: 0xfcc13472c25b7ae1b1aa0dd29514266f8b3183b60daa97aa902737e529d1eae4

The contract isn't swapping into the gas token gETH (the balance is 0), but swaps fine to the destination token USDC.

I need help figuring out why swapTokensForExactTokens doesn't work as intended.

socket-security · 2023-12-13T16:06:15Z

Updated dependencies detected. Learn more about Socket for GitHub ↗︎

Packages	Version	New capabilities	Transitives	Size	Publisher
@zetachain/toolkit	4.0.0...5.0.0	environment	`+9/-16`	4.46 MB

fadeev · 2023-12-13T16:23:50Z

Alternatively, we can use a different approach were we swap all incoming tokens into the gas token using _doSwap, deduct the gas fee amount, and swap the rest again using _doSwap into the target token.

@andresaiello please, let me know if you think this solution is ok or if we should try to fix swapTokensForExactTokens.

andresaiello · 2023-12-13T16:51:55Z

@fadeev I agree with the approach. This contract was designed before ERC20 support. I like the first approach

fadeev · 2023-12-13T16:55:34Z

@fadeev I agree with the approach. This contract was designed before ERC20 support. I like the first approach

Then I need help debugging swapTokensForExactTokens 😬

fadeev · 2023-12-13T17:11:05Z

I've tried the second approach (swapping all to gas tokens, deducting the gas fee, then swapping to destination token), and I'm getting the same result (tMATIC -> Goerli USDC, I'm getting 0 gETH and a proper amount of USDC).

        (address gasZRC20, uint256 gasFee) = IZRC20(targetTokenAddress)
            .withdrawGasFee();

        uint256 gasOutput = SwapHelperLib._doSwap(
            systemContract.wZetaContractAddress(),
            systemContract.uniswapv2FactoryAddress(),
            systemContract.uniswapv2Router02Address(),
            zrc20,
            amount,
            gasZRC20,
            0
        );

        SwapHelperLib._doSwap(
            systemContract.wZetaContractAddress(),
            systemContract.uniswapv2FactoryAddress(),
            systemContract.uniswapv2Router02Address(),
            gasZRC20,
            gasOutput - gasFee,
            targetTokenAddress,
            0
        );

https://zetachain-athens-3.blockscout.com/address/0x6bf6ae7d9763eb1e42d8c7e9D31A5C23Be192a70

andresaiello · 2023-12-13T17:26:37Z

mmmm targetTokenAddress is USDC? I guess to calculate the fee should be the native token of destination chain

fadeev · 2023-12-13T17:36:08Z

mmmm targetTokenAddress is USDC? I guess to calculate the fee should be the native token of destination chain

@andresaiello you mean IZRC20(targetTokenAddress).withdrawGasFee()? When target token is USDC it returns ZRC-20 gETH address, so I don't think there is a problem there.

fadeev · 2023-12-13T17:38:01Z

withdrawGasFee() always returns a gas token:

https://github.com/zeta-chain/protocol-contracts/blob/fbf8687395ce15429ec0bb6ef8342e3c9f23cb6e/contracts/zevm/ZRC20.sol#L237

andresaiello · 2023-12-13T17:47:05Z

are we sure gasFee is returning >0 ?

fadeev · 2023-12-13T17:57:07Z

are we sure gasFee is returning >0 ?

It is returning a positive integer, yes.

fadeev · 2023-12-13T18:01:22Z

are we sure gasFee is returning >0 ?

For example, for Goerli USDC the gas fee is 3500000.

https://zetachain-athens-3.blockscout.com/address/0xDf5C8854C2A9822e15470547e139451af892124F

fadeev · 2023-12-13T18:02:44Z

I'm just using public variables to output some debug information as events don't show up in the explorer.

fadeev · 2023-12-14T10:15:28Z

When I manually increase gasFee to a larger amount, I can see that swapTokensForExactTokens actually swaps tokens just fine. The problem is with IZRC20(targetTokenAddress).withdraw(recipientAddress, outputAmount), it's throwing an error:

0x8e03367d2cd6ac000e3186c86fe5939daa98ed544ffbf6238ee31000ab056470: 80001 → 7001: PendingRevert (contract call failed: method 'depositAndCall', contract '0xEdf1c3275d13489aCdC6cD6eD246E72458B8795B': execution reverted: ret 0x10bad147: evm transaction execution failed)

omnichain/swap/contracts/Swap.sol

andresaiello · 2023-12-15T18:45:09Z

omnichain/swap/contracts/Swap.sol

-            outputAmount - gasFee
-        );
+        IZRC20(gasZRC20).approve(gasZRC20, gasFee);
+        // IZRC20(targetTokenAddress).withdraw(recipientAddress, outputAmount);


why you don't need the abi.encode? will check if is the same without... IZRC20(targetTokenAddress).withdraw(abi.encodePacked(recipientAddress), outputAmount);

fadeev · 2023-12-17T07:45:50Z

Amounts 0 will be the same you sent as input
Then your line 70 is returning 0

@andresaiello I don't think that's the case.

Here's an example of me swapping 10 tMATIC for Goerli USDC. The state of the contract is a result of a single transaction.

https://zetachain-athens-3.blockscout.com/address/0x7c732C6A614ecaD95B2953C624d39825f58C6F5C

I’m using public variables to debug the contract. inputForGas (amount[0] of swapTokensForExactTokens) is not the same as input (which is amount). inputForGas actually represents the amount of tMATIC that was swapped to cover gas fees. You can see that the contract successfully swapped to get gasFee amount of gETH to cover gas. Please, ignore Blockscout's bug where it shows 0.00 gETH, you can check the actual value through the ZRC-20 gETH contract.

At the end of the day, the contract has gasFee worth of gETH to cover withdraw fee as well as outputAmount worth of USDC that I'm trying to withdraw. And the withdraw process fails.

fadeev · 2023-12-17T08:07:22Z

In a separate contract I've also tried setting gasFee manually and the contract had up to 0.1 gETH for fees, but withdraw still kept failing, so it's probably not due to lack of tokens for gas.

fadeev · 2023-12-17T08:08:52Z

Could it be that it's getting confused because USDC has uses different decimal amount that gas tokens?

socket-security · 2023-12-18T16:15:50Z

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

fadeev · 2023-12-19T14:39:09Z

@SocketSecurity ignore @types/[email protected]

fadeev · 2023-12-21T14:29:29Z

@andresaiello please, review.

messaging/counter/package.json

fadeev added 2 commits December 13, 2023 19:23

Swap ERC-20 support

ea5d01a

toolkit

5a247d2

andresaiello reviewed Dec 15, 2023

View reviewed changes

omnichain/swap/contracts/Swap.sol Show resolved Hide resolved

andresaiello reviewed Dec 15, 2023

View reviewed changes

fix Swap

8cd0207

fadeev added 2 commits December 18, 2023 20:56

Applied approve targetTokenAddress fix

79a6d21

interact

9f8fa46

updated

411e3cd

fadeev mentioned this pull request Dec 19, 2023

Swap tutorial: ERC-20 support zeta-chain/docs#209

Merged

toolkit v5

68cdeed

fadeev marked this pull request as ready for review December 21, 2023 14:30

fadeev requested a review from lucas-janon as a code owner December 21, 2023 14:30

fadeev changed the title ~~Swap ERC-20 support~~ Swap ERC-20 support, update to toolkit v5 Dec 21, 2023

andresaiello reviewed Dec 21, 2023

View reviewed changes

messaging/counter/package.json Outdated Show resolved Hide resolved

andresaiello approved these changes Dec 21, 2023

View reviewed changes

@zetachain/toolkit: ^5.0.0

f4bd7cc

andresaiello approved these changes Dec 21, 2023

View reviewed changes

fadeev merged commit 859ce99 into main Dec 21, 2023
5 checks passed

fadeev deleted the swap-erc20-support branch December 21, 2023 15:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Swap ERC-20 support, update to toolkit v5 #99

Swap ERC-20 support, update to toolkit v5 #99

fadeev commented Dec 13, 2023 •

edited

Loading

socket-security bot commented Dec 13, 2023 •

edited

Loading

fadeev commented Dec 13, 2023 •

edited

Loading

andresaiello commented Dec 13, 2023

fadeev commented Dec 13, 2023

fadeev commented Dec 13, 2023

andresaiello commented Dec 13, 2023

fadeev commented Dec 13, 2023

fadeev commented Dec 13, 2023

andresaiello commented Dec 13, 2023

fadeev commented Dec 13, 2023

fadeev commented Dec 13, 2023

fadeev commented Dec 13, 2023 •

edited

Loading

fadeev commented Dec 14, 2023

andresaiello Dec 15, 2023

fadeev commented Dec 17, 2023 •

edited

Loading

fadeev commented Dec 17, 2023

fadeev commented Dec 17, 2023

socket-security bot commented Dec 18, 2023 •

edited

Loading

fadeev commented Dec 19, 2023

fadeev commented Dec 21, 2023

	uint256 outputAmount = SwapHelperLib._doSwap(
	systemContract.wZetaContractAddress(),
	systemContract.uniswapv2FactoryAddress(),
	systemContract.uniswapv2Router02Address(),
	zrc20,
	amount,
	targetTokenAddress,
	0
	);

	(address gasZRC20, uint256 gasFee) = IZRC20(targetTokenAddress)
	.withdrawGasFee();

	if (gasZRC20 != targetTokenAddress) revert WrongGasContract();
	if (gasFee >= outputAmount) revert NotEnoughToPayGasFee();

Swap ERC-20 support, update to toolkit v5 #99

Swap ERC-20 support, update to toolkit v5 #99

Conversation

fadeev commented Dec 13, 2023 • edited Loading

socket-security bot commented Dec 13, 2023 • edited Loading

fadeev commented Dec 13, 2023 • edited Loading

andresaiello commented Dec 13, 2023

fadeev commented Dec 13, 2023

fadeev commented Dec 13, 2023

andresaiello commented Dec 13, 2023

fadeev commented Dec 13, 2023

fadeev commented Dec 13, 2023

andresaiello commented Dec 13, 2023

fadeev commented Dec 13, 2023

fadeev commented Dec 13, 2023

fadeev commented Dec 13, 2023 • edited Loading

fadeev commented Dec 14, 2023

andresaiello Dec 15, 2023

Choose a reason for hiding this comment

fadeev commented Dec 17, 2023 • edited Loading

fadeev commented Dec 17, 2023

fadeev commented Dec 17, 2023

socket-security bot commented Dec 18, 2023 • edited Loading

fadeev commented Dec 19, 2023

fadeev commented Dec 21, 2023

fadeev commented Dec 13, 2023 •

edited

Loading

socket-security bot commented Dec 13, 2023 •

edited

Loading

fadeev commented Dec 13, 2023 •

edited

Loading

fadeev commented Dec 13, 2023 •

edited

Loading

fadeev commented Dec 17, 2023 •

edited

Loading

socket-security bot commented Dec 18, 2023 •

edited

Loading